Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add SVG Sprite Module for icons #1808

Merged
merged 13 commits into from Apr 25, 2023
Merged

Add SVG Sprite Module for icons #1808

merged 13 commits into from Apr 25, 2023

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Apr 18, 2023 •
edited

Fixes

Fixes #985 by @obulat

Description

This PR adds the Nuxt SVG Sprite Module for icons.

To minimize changes, I wrapped the SvgIcon component provided by the module in the VIcon component.

This PR also adds documentation page about the icons. I'm not sure where it should be placed.

Testing Instructions

All the snapshot tests should pass.

Checklist

  • My pull request has a descriptive title (not a vague title like
    Update index.md).
  • My pull request targets the default branch of the repository (main) or
    a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible
    errors.

Developer Certificate of Origin

Developer Certificate of Origin 
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@obulat obulat requested review from a team as code owners April 18, 2023 03:52
@openverse-bot openverse-bot added this to Needs review in Openverse PRs Apr 18, 2023
@obulat obulat added 🟨 priority: medium Not blocking but should be addressed soon ✨ goal: improvement Improvement to an existing user-facing feature 💻 aspect: code Concerns the software code in the repository 🧱 stack: frontend Related to the Nuxt frontend labels Apr 18, 2023
@github-actions
Copy link

github-actions bot commented Apr 18, 2023 •
edited

Size Change: -1.89 kB (0%)

Total Size: 851 kB

Filename Size Change
./frontend/.nuxt/dist/client/app.js 126 kB -508 B (0%)
./frontend/.nuxt/dist/client/app.modern.js 118 kB -516 B (0%)
./frontend/.nuxt/dist/client/commons/app.js 90.4 kB +29 B (0%)
./frontend/.nuxt/dist/client/commons/app.modern.js 78.5 kB -16 B (0%)
./frontend/.nuxt/dist/client/components/v-all-results-grid.js 5.51 kB -131 B (-2%)
./frontend/.nuxt/dist/client/components/v-all-results-grid.modern.js 5.38 kB -106 B (-2%)
./frontend/.nuxt/dist/client/components/v-audio-details.js 2.43 kB -55 B (-2%)
./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.js 514 B -29 B (-5%) ✅
./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.modern.js 520 B -28 B (-5%) ✅
./frontend/.nuxt/dist/client/components/v-content-link.js 974 B -148 B (-13%) 👏
./frontend/.nuxt/dist/client/components/v-content-link.modern.js 973 B -130 B (-12%) 👏
./frontend/.nuxt/dist/client/components/v-content-report-button.js 715 B -69 B (-9%) ✅
./frontend/.nuxt/dist/client/components/v-content-report-button.modern.js 716 B -71 B (-9%) ✅
./frontend/.nuxt/dist/client/components/v-content-report-form.js 3.74 kB -37 B (-1%)
./frontend/.nuxt/dist/client/components/v-content-report-form.modern.js 3.56 kB -34 B (-1%)
./frontend/.nuxt/dist/client/components/v-content-report-popover.js 1.11 kB -58 B (-5%) ✅
./frontend/.nuxt/dist/client/components/v-content-report-popover.modern.js 4.1 kB -86 B (-2%)
./frontend/.nuxt/dist/client/components/v-external-search-form.js 1.79 kB -67 B (-4%)
./frontend/.nuxt/dist/client/components/v-external-search-form.modern.js 1.78 kB -70 B (-4%)
./frontend/.nuxt/dist/client/components/v-external-source-list.js 786 B -58 B (-7%) ✅
./frontend/.nuxt/dist/client/components/v-external-source-list.modern.js 787 B -59 B (-7%) ✅
./frontend/.nuxt/dist/client/components/v-home-gallery.modern.js 5.24 kB -14 B (0%)
./frontend/.nuxt/dist/client/components/v-image-carousel.modern.js 4.7 kB -13 B (0%)
./frontend/.nuxt/dist/client/components/v-image-details.js 2.04 kB -45 B (-2%)
./frontend/.nuxt/dist/client/components/v-no-results.js 723 B -34 B (-4%)
./frontend/.nuxt/dist/client/components/v-no-results.modern.js 722 B -33 B (-4%)
./frontend/.nuxt/dist/client/components/v-search-grid.js 5.6 kB -85 B (-1%)
./frontend/.nuxt/dist/client/components/v-search-grid.modern.js 5.53 kB -77 B (-1%)
./frontend/.nuxt/dist/client/components/v-sources-table.js 15.1 kB -30 B (0%)
./frontend/.nuxt/dist/client/components/v-sources-table.modern.js 15.1 kB -28 B (0%)
./frontend/.nuxt/dist/client/pages/audio/_id/index.js 5.6 kB -65 B (-1%)
./frontend/.nuxt/dist/client/pages/audio/_id/index.modern.js 4.94 kB -30 B (-1%)
./frontend/.nuxt/dist/client/pages/image/_id/index.js 6.59 kB -83 B (-1%)
./frontend/.nuxt/dist/client/pages/image/_id/index.modern.js 5.81 kB -36 B (-1%)
./frontend/.nuxt/dist/client/pages/image/_id/report.modern.js 4.23 kB -28 B (-1%)
./frontend/.nuxt/dist/client/pages/index.modern.js 7.27 kB -12 B (0%)
./frontend/.nuxt/dist/client/vendors/app.js 64.6 kB +478 B (+1%)
./frontend/.nuxt/dist/client/vendors/app.modern.js 63.8 kB +524 B (+1%)
ℹ️ View Unchanged
Filename Size Change
./frontend/.nuxt/dist/client/234.js 272 B 0 B
./frontend/.nuxt/dist/client/234.modern.js 277 B 0 B
./frontend/.nuxt/dist/client/235.js 1.85 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/loading-icon.js 751 B -1 B (0%)
./frontend/.nuxt/dist/client/components/loading-icon.modern.js 757 B -1 B (0%)
./frontend/.nuxt/dist/client/components/table-sort-icon.js 514 B -1 B (0%)
./frontend/.nuxt/dist/client/components/table-sort-icon.modern.js 519 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-cell.js 392 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-cell.modern.js 396 B 0 B
./frontend/.nuxt/dist/client/components/v-audio-details.modern.js 1.77 kB -5 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.js 1.02 kB 0 B
./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.modern.js 1.02 kB 0 B
./frontend/.nuxt/dist/client/components/v-audio-track.js 5.6 kB +4 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-track.modern.js 5.54 kB -5 B (0%)
./frontend/.nuxt/dist/client/components/v-bone.js 688 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-bone.modern.js 693 B 0 B
./frontend/.nuxt/dist/client/components/v-box-layout.js 1.28 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-box-layout.modern.js 1.28 kB 0 B
./frontend/.nuxt/dist/client/components/v-content-page.js 524 B 0 B
./frontend/.nuxt/dist/client/components/v-content-page.modern.js 529 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-copy-button.js 4 kB +5 B (0%)
./frontend/.nuxt/dist/client/components/v-copy-button.modern.js 4 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-copy-license.js 1.71 kB -4 B (0%)
./frontend/.nuxt/dist/client/components/v-copy-license.modern.js 1.69 kB 0 B
./frontend/.nuxt/dist/client/components/v-copy-license/components/v-error-image/components/v-media-reuse/components/v-search-grid/d219393b.js 10 kB +3 B (0%)
./frontend/.nuxt/dist/client/components/v-copy-license/components/v-error-image/components/v-media-reuse/components/v-search-grid/d219393b.modern.js 10 kB +4 B (0%)
./frontend/.nuxt/dist/client/components/v-dmca-notice.js 753 B 0 B
./frontend/.nuxt/dist/client/components/v-dmca-notice.modern.js 758 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-error-image.js 1.7 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-error-image.modern.js 1.68 kB -3 B (0%)
./frontend/.nuxt/dist/client/components/v-error-section.js 372 B 0 B
./frontend/.nuxt/dist/client/components/v-error-section.modern.js 375 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-full-layout.js 2.13 kB 0 B
./frontend/.nuxt/dist/client/components/v-full-layout.modern.js 2.1 kB -3 B (0%)
./frontend/.nuxt/dist/client/components/v-grid-skeleton.js 1.61 kB 0 B
./frontend/.nuxt/dist/client/components/v-grid-skeleton.modern.js 1.62 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-home-gallery.js 5.27 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-homepage-content.js 1.76 kB -5 B (0%)
./frontend/.nuxt/dist/client/components/v-homepage-content.modern.js 1.73 kB 0 B
./frontend/.nuxt/dist/client/components/v-image-carousel.js 4.73 kB 0 B
./frontend/.nuxt/dist/client/components/v-image-cell.js 1.59 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-image-cell.modern.js 1.58 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-image-details.modern.js 1.41 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-image-grid.js 2.67 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-image-grid.modern.js 2.55 kB -4 B (0%)
./frontend/.nuxt/dist/client/components/v-license-tab-panel.js 1.24 kB 0 B
./frontend/.nuxt/dist/client/components/v-license-tab-panel.modern.js 1.21 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-load-more.js 809 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-load-more.modern.js 709 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-media-license.js 829 B 0 B
./frontend/.nuxt/dist/client/components/v-media-license.modern.js 837 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-media-reuse.js 2.31 kB 0 B
./frontend/.nuxt/dist/client/components/v-media-reuse.modern.js 2.29 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-media-tag.js 416 B 0 B
./frontend/.nuxt/dist/client/components/v-media-tag.modern.js 420 B 0 B
./frontend/.nuxt/dist/client/components/v-modal.js 1.01 kB 0 B
./frontend/.nuxt/dist/client/components/v-modal.modern.js 995 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-radio.js 1.54 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-radio.modern.js 1.5 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-related-audio.js 1.27 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-related-audio.modern.js 1.27 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-related-images.js 3.25 kB +6 B (0%)
./frontend/.nuxt/dist/client/components/v-related-images.modern.js 3.12 kB -5 B (0%)
./frontend/.nuxt/dist/client/components/v-report-desc-form.js 977 B 0 B
./frontend/.nuxt/dist/client/components/v-report-desc-form.modern.js 980 B 0 B
./frontend/.nuxt/dist/client/components/v-row-layout.js 1.68 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-row-layout.modern.js 1.68 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-scroll-button.js 824 B 0 B
./frontend/.nuxt/dist/client/components/v-scroll-button.modern.js 829 B 0 B
./frontend/.nuxt/dist/client/components/v-search-results-title.js 599 B 0 B
./frontend/.nuxt/dist/client/components/v-search-results-title.modern.js 604 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-server-timeout.js 299 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-server-timeout.modern.js 302 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-sketch-fab-viewer.js 1.01 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-sketch-fab-viewer.modern.js 912 B 0 B
./frontend/.nuxt/dist/client/components/v-snackbar.js 1.16 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-snackbar.modern.js 1.17 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-warning-suppressor.js 306 B 0 B
./frontend/.nuxt/dist/client/components/v-warning-suppressor.modern.js 311 B 0 B
./frontend/.nuxt/dist/client/pages/about.js 1.4 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/about.modern.js 1.4 kB 0 B
./frontend/.nuxt/dist/client/pages/external-sources.js 1.56 kB -4 B (0%)
./frontend/.nuxt/dist/client/pages/external-sources.modern.js 1.56 kB +2 B (0%)
./frontend/.nuxt/dist/client/pages/feedback.js 1.34 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/feedback.modern.js 1.34 kB +2 B (0%)
./frontend/.nuxt/dist/client/pages/image/_id/report.js 1.27 kB +2 B (0%)
./frontend/.nuxt/dist/client/pages/index.js 7.33 kB -4 B (0%)
./frontend/.nuxt/dist/client/pages/preferences.js 1.32 kB -2 B (0%)
./frontend/.nuxt/dist/client/pages/preferences.modern.js 1.32 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/privacy.js 1.01 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/privacy.modern.js 1.02 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/search-help.js 1.6 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/search-help.modern.js 1.58 kB 0 B
./frontend/.nuxt/dist/client/pages/search.js 2.19 kB -2 B (0%)
./frontend/.nuxt/dist/client/pages/search.modern.js 2.04 kB -2 B (0%)
./frontend/.nuxt/dist/client/pages/search/audio.js 3.61 kB 0 B
./frontend/.nuxt/dist/client/pages/search/audio.modern.js 3.51 kB -5 B (0%)
./frontend/.nuxt/dist/client/pages/search/image.js 2.84 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/search/image.modern.js 2.74 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/search/index.js 443 B 0 B
./frontend/.nuxt/dist/client/pages/search/index.modern.js 448 B +1 B (0%)
./frontend/.nuxt/dist/client/pages/search/model-3d.js 243 B 0 B
./frontend/.nuxt/dist/client/pages/search/model-3d.modern.js 246 B 0 B
./frontend/.nuxt/dist/client/pages/search/search-page.types.js 266 B 0 B
./frontend/.nuxt/dist/client/pages/search/search-page.types.modern.js 271 B +1 B (0%)
./frontend/.nuxt/dist/client/pages/search/video.js 240 B 0 B
./frontend/.nuxt/dist/client/pages/search/video.modern.js 243 B -1 B (0%)
./frontend/.nuxt/dist/client/pages/sources.js 1.52 kB -3 B (0%)
./frontend/.nuxt/dist/client/pages/sources.modern.js 1.52 kB 0 B
./frontend/.nuxt/dist/client/runtime.js 2.72 kB 0 B
./frontend/.nuxt/dist/client/runtime.modern.js 2.72 kB 0 B

compressed-size-action

sarayourfriend
sarayourfriend requested changes Apr 18, 2023
View reviewed changes
Copy link
Contributor

@sarayourfriend sarayourfriend left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. I have a couple clarifying questions but in the meantime the Storybook fix is the only requested change.

documentation/guides/frontend/icons.md Outdated Show resolved Hide resolved
frontend/nuxt.config.ts Show resolved Hide resolved
documentation/guides/frontend/icons.md Show resolved Hide resolved
frontend/test/unit/setup.js Show resolved Hide resolved
@github-actions
Copy link

Full-stack documentation: https://docs.openverse.org/_preview/1808

Please note that GitHub pages takes a little time to deploy newly pushed code, if the links above don't work or you see old versions, wait 5 minutes and try again.

You can check the GitHub pages deployment action list to see the current status of the deployments.

sarayourfriend
sarayourfriend approved these changes Apr 20, 2023
View reviewed changes
Copy link
Contributor

@sarayourfriend sarayourfriend left a comment •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM once the playwright tests pass 🙂. The plan to remove the other svg module in a separate PR sounds good. Is there an issue to do that?

@obulat
Copy link
Contributor Author

obulat commented Apr 20, 2023

Is there an issue to do that?

I'll open the issue once the Playwright tests pass :)

@obulat obulat mentioned this pull request Apr 20, 2023
Closed
@obulat obulat mentioned this pull request Apr 21, 2023
Merged
8 tasks
@obulat obulat added 🟥 priority: critical Must be addressed ASAP and removed 🟨 priority: medium Not blocking but should be addressed soon labels Apr 25, 2023
dhruvkb
dhruvkb approved these changes Apr 25, 2023
View reviewed changes
Copy link
Member

@dhruvkb dhruvkb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! The added documentation is very helpful too.

Openverse PRs automation moved this from Needs review to Reviewer approved Apr 25, 2023
@obulat obulat merged commit 7a071e2 into main Apr 25, 2023
44 checks passed
Openverse PRs automation moved this from Reviewer approved to Merged! Apr 25, 2023
@obulat obulat deleted the add/svg_icon_sprite branch April 25, 2023 15:25
@obulat obulat mentioned this pull request Aug 10, 2023
Closed
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dhruvkb dhruvkb dhruvkb approved these changes

@sarayourfriend sarayourfriend sarayourfriend approved these changes

Assignees
No one assigned
Labels
💻 aspect: code Concerns the software code in the repository ✨ goal: improvement Improvement to an existing user-facing feature 🟥 priority: critical Must be addressed ASAP 🧱 stack: frontend Related to the Nuxt frontend
Projects
No open projects
Openverse PRs
  
Merged!
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Use sprites for SVG icons
3 participants
@obulat @dhruvkb @sarayourfriend